/*
 * Copyright 2004 original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.jbfilter.core.fcomps.single;


/**
 * A filter component which offers common string filtering options, like case sensitivity
 * and regular expression filtering.
 * @author Marcus Adrian
 * @param <E> the type of the beans to filter
 */
public interface StringFilterComponent<E>
	extends
		RegexFilterComponent<E>,
		ContainsStringFilterComponent<E> {

	/**
	 * The clean value for this member. Set it to {@code null} to ignore while clearing.
	 * @param regexCleanValue
	 */
	void setRegexCleanValue(Boolean regexCleanValue);
	/**
	 * Defaults to {@code false}.
	 * @see #setRegexCleanValue(Boolean)
	 */
	Boolean getRegexCleanValue();
	
	/**
	 * Switches on/off the regular expression mode.
	 * @param regex
	 */
	void setRegex(boolean regex);
	/**
	 * Indicates if the regular expression mode is on/off.
	 * @return {@code true} if on, {@code false} if off,  
	 */
	boolean isRegex();

}
